home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / arman10.zip / AREAMAN.DOC < prev    next >
Text File  |  1992-07-16  |  12KB  |  244 lines
  1.  
  2. ╓─────────────────────────────────────────────────────────────────────────╖
  3. ║                         Area Manager Version 1.0                        ║
  4. ║               Copyright (c) 1992 by Clayton & Associates                ║
  5. ║                           All Rights Reserved                           ║
  6. ╟─────────────────────────────────────────────────────────────────────────╢
  7. ║                  Released: Thursday, July 16th, 1992.                   ║
  8. ║ **Please scan files for viruses before use!  Just a safety precaution** ║
  9. ╙─────────────────────────────────────────────────────────────────────────╜
  10.  
  11.  
  12. ╓─────────────────────────────────────────────────────────────────────────╖
  13. ║ AREAMAN Disclaimer and Registration Information                         ║
  14. ╙─────────────────────────────────────────────────────────────────────────╜
  15.  
  16. AREAMAN is provided on an "as is" basis, without any warranty of any kind.
  17. We, at Clayton & Associates, do not warrant, guarantee or make any
  18. representations regarding the use of, or the results of AREAMAN.  We are
  19. also, in no way possible, responsible for any damages sustained either
  20. directly, or indirectly from the use of AREAMAN.
  21.  
  22. A registration form is included in this package.  You are required to
  23. register this after 31 days of use.  This is a shareware product, but
  24. please support the shareware aspect.  Registration is only $5.00 so we are
  25. not asking alot.  There have been many late nights spent writing AREAMAN
  26. and this way we know our program is being appreciated.
  27.  
  28. When you run AREAMAN, there will be a number displayed in the bottom right
  29. of the screen.  It is labeled as a PreRegistration number.  When, and if you
  30. decide to register your copy of AREAMAN with us, please remember to include
  31. this number with your registration fee as this number is required by us to
  32. create your keyfile.
  33.  
  34.  
  35. ╓─────────────────────────────────────────────────────────────────────────╖
  36. ║ What is AREAMAN you say?                                                ║
  37. ╙─────────────────────────────────────────────────────────────────────────╜
  38.  
  39. AREAMAN will perform two operations.  It will create an ALLFILES.LST and a
  40. NEWFILES.LST for you.  While creating these two files, many other things
  41. happen.
  42.  
  43. 1.      AREAMAN will check to see if a download counter and/or download
  44.         description is present and if not, one of the following
  45.         will added:
  46.  
  47.         a)  <0> Description not available
  48.         b)  [0] Description not available
  49.         c)  (0) Description not available
  50.         d)  {0} Description not available
  51.  
  52.         One of the four choices above is available for selection through the
  53.         configuration file.  The choice you make is of GREAT importance and
  54.         must match the selection you chose in your SuperBBS configuration
  55.         file.  If you select the wrong one, your two file listings could be
  56.         written with improper file descriptions.
  57.  
  58. 2.      AREAMAN will create a SUB-Header before each file area is listed.
  59.         You have the option of using the default one created by the program
  60.         or creating one of your own which AREAMAN will incorporate into the
  61.         final lists.  If you decide to create your own, there are options
  62.         available to you and also certain rules that you must follow.
  63.         All of these will be explained later.
  64.  
  65. 3.      AREAMAN will also include at the top of each file, a MAIN-Header
  66.         file which is up to you to design.  If there is not one available,
  67.         or you specify a filename that does not exist, nothing will be done.
  68.  
  69.  
  70. ╓─────────────────────────────────────────────────────────────────────────╖
  71. ║ Configuration File for AREAMAN                                          ║
  72. ╙─────────────────────────────────────────────────────────────────────────╜
  73.  
  74. A sample configuration file is shown below for your viewings.  AREAMAN
  75. requires a configuration file by the name of "AREAMAN.CFG" and will not run
  76. without this file.  This file MUST also be located in the same directory
  77. that the "AREAMAN.EXE" file is located in.  You can create this with MS-DOS's
  78. Edlin or any other ASCII Editor.  All lines will be described as to what they
  79. do in the example below:
  80.  
  81.   Line 1:  This is the filename.ext of the MAIN Header file for your
  82.            ALLFILES listing.  DO NOT include a drive letter or path!
  83.  
  84.   Line 2:  This is the filename.ext of the MAIN Header file for your
  85.            NEWFILES listing.  DO NOT include a drive letter or path!
  86.  
  87.   Line 3:  This is the filename.ext of the SUB Header file which is
  88.            inserted above each file area encountered while creating
  89.            both the ALLFILES and NEWFILES lists.  DO NOT include a
  90.            drive letter or path!
  91.  
  92.   Line 4:  What style brackets you have chosen for SuperBBS
  93.  
  94.            Your choices are as follows:
  95.  
  96.            1 - <>       2 - []       3 - ()       4 - {}
  97.  
  98.            IT IS EXTREMELY IMPORTANT THAT YOU CHOOSE THE RIGHT ONE!!
  99.  
  100.   Line 5:  This is the number of days used to determine whether a file
  101.            gets included in you NEWFILES listing.  If the file is more
  102.            than this number of days old, it will not be included.
  103.  
  104.   Line 6:  This is the drive and path to your FLSEARCH.CTL file.  DO NOT
  105.            include a filename.ext as AREAMAN will add in the filename
  106.            "FLSEARCH.CTL".
  107.  
  108.  
  109. EXAMPLE CONFIGURATION FILE          This column is for info only.
  110.  
  111.         ALLFILES.HDR                ; Name of header file for ALLFILES list
  112.         NEWFILES.HDR                ; Name of header file for NEWFILES list
  113.         SUB.HDR                     ; Sub Header placed before each area
  114.         1                           ; Bracket type used in "FILES.BBS"
  115.         30                          ; # of days for inclusion in NEWFILES.LST
  116.         C:\SUPERBBS\                ; Path to "FLSEARCH.CTL"
  117.  
  118. ╓─────────────────────────────────────────────────────────────────────────╖
  119. ║ Running AREAMAN on your SuperBBS System                                 ║
  120. ╙─────────────────────────────────────────────────────────────────────────╜
  121.  
  122. This is as easy as 1-2-3.  First, copy AREAMAN.EXE into a directory.  Second,
  123. create your configuration file (AREAMAN.CFG).  Third, either execute AREAMAN
  124. from the DOS command line or place it into one of your event batch files.
  125. Remember that the configuration file, and all header files MUST reside in the
  126. same directory as the AREAMAN.EXE program.  Please note that you will need to
  127. have an "FLSEARCH.CTL" file to run this program.  There are many utilities
  128. out there can create this file for you.  We used a program called "SBBSUTIL"
  129. to create this file while we were developing AREAMAN and ran into no problems.
  130.  
  131. AREAMAN has ONLY been tested on a SuperBBS system.  It will work with other
  132. systems that store their file listings in the same format as SuperBBS does
  133. and the file listing the downloadable files is called "FILES.BBS".
  134.  
  135. AREAMAN has been tested but may still contain some problems that we do not
  136. know about as of just yet.  If you find find a bug, have an idea of some
  137. feature you would like added, or an idea of something you think should
  138. be changed, feel free to let us know and we will look into it.  If we
  139. receive an idea that we incorporate into AREAMAN, we will be sure to give
  140. you an honourable mention in this documentation and will send you a copy
  141. of the latest version when released.
  142.  
  143. ╓─────────────────────────────────────────────────────────────────────────╖
  144. ║ File format for your SUB HEADER file                                    ║
  145. ╙─────────────────────────────────────────────────────────────────────────╜
  146.  
  147.  
  148. Please note!!
  149.         The unregistered version will not allow the use of a user definable
  150.         SUB-Header file.  If you specify one in the configuration file, and
  151.         you are running an unregistered version, the program will ignore
  152.         this file and will use the built in sub-header.  To gain use of this
  153.         feature, PLEASE REGISTER.
  154.  
  155. The SUB Header file that you can create for use in your file listings has
  156. certain limitations and options available to you.
  157.  
  158. Limitations:
  159.  
  160.    There aren't many except that the file is limited to TEN (10) lines and
  161. must not exceed 79 characters in length.  The reason for the limit of 79 was
  162. chosen to avoid screen wrap-around when viewing this file from the DOS
  163. prompt.  Please adhere to this figure.  If you do not, then usually only
  164. the first line of your file will be included in the lists.
  165.  
  166. Options:
  167.  
  168.    We have incorporated something that we feel would be of great flexibility
  169. to most sysops out there and we hope that these options will be appreciated
  170. and used extensively.  We have incorporated the ability to use replaceable
  171. parameters.
  172.  
  173. They are as follows:
  174.  
  175.           %1 - This parameter will be replaced with the name of your
  176.                file area.  The % tells the program to start at the
  177.                column where the % is found and replace it in a left
  178.                justified format.
  179.  
  180.           @1 - Is essentially the same as above but the area name will
  181.                be centered using the column that the @ symbol is found
  182.                in as the center point.
  183.  
  184.           %2 - This parameter is replaced with the total number of files
  185.                that are in the area in a left justified format.
  186.  
  187.           %3 - This parameter is replaced with the total number of
  188.                downloads for the area in a left justified format.
  189.  
  190.           %4 - This parameter will be replaced with the total file size
  191.                for the area.  The number that is replaced is the total
  192.                file size in integer style numbers in a left justified
  193.                format.  In other words, NO decimals.
  194.                           eg.   245680
  195.                           NOT   245.680K
  196.  
  197. Please note that the replacement text will vary in length and therefore
  198. you must be careful when placing text to the right of these parameters.
  199. If your text is placed too close, it will be overwritten!
  200.  
  201.  
  202. ╓─────────────────────────────────────────────────────────────────────────╖
  203. ║ Other Information and the History of AREAMAN                            ║
  204. ╙─────────────────────────────────────────────────────────────────────────╜
  205.  
  206. Version 1.0  -     Written in Quick Basic 4.5 and released on July 16, 1992
  207.                    to the general public.  Initial testing was performed
  208.                    on Air Waves SuperBBS with the help of the Sysop 'Cal
  209.                    Gardner' who, YES, as most of us know is the author of
  210.                    "The Quote Of The Day" (TQOTD). (Great program).  He was
  211.                    a great help and inspiration to get me to write this
  212.                    program.  Thanks Cal!
  213.  
  214.  
  215. If you have any questions pertaining to AREAMAN or any other inquiries, you
  216. may contact me via the following:
  217.  
  218. Company:                             BBS:
  219. Clayton & Associates                 Air Waves SuperBBS HST
  220. Clayton Mattatall                    1200-9600 Bps/HST/MNP
  221. 92 Green Maple Drive                 (416) 984-4076
  222. St. Catharines, Ontario              FidoNet: 1:247/117
  223. CANADA       L2P 3P5                 SIGnet: 34:4416/0
  224.  
  225. ╓─────────────────────────────────────────────────────────────────────────╖
  226. ║ AREAMAN Support Systems                                                 ║
  227. ╙─────────────────────────────────────────────────────────────────────────╜
  228.  
  229. Canada:
  230.  
  231. Air Waves SuperBBS HST      St. Catharines, ON, Canada      +1-416-984-4076
  232.   USR 9600 Bps                FidoNet 1:247/117
  233.  
  234.  
  235. Clayton & Associates has made every effort to supply trademark information
  236. about company names, products and services mentioned in this documentation.
  237. Clayton & Associates cannot attest to the accuracy of this information.
  238.  
  239. EDLIN and MS-DOS are registered trademarks of Microsoft Corporation.
  240.  
  241. SuperBBS is copyright by Aki Antman
  242.  
  243. "The Quote Of The Day" is copyright by Cal Gardner
  244.